Eclipse Platform
Pre-release 3.0

org.eclipse.ui.contexts
Interface IContextActivationService

All Known Subinterfaces:
ICompoundContextActivationService, IMutableContextActivationService

public interface IContextActivationService

An instance of this interface allows clients to manage context activation.

This interface is not intended to be extended or implemented by clients.

EXPERIMENTAL

Since:
3.0
See Also:
ContextActivationServiceFactory

Method Summary
 void addContextActivationServiceListener(IContextActivationServiceListener contextActivationServiceListener)
          Registers an instance of IContextActivationServiceListener to listen for changes to properties of this instance.
 Set getActiveContextIds()
          Returns the set of identifiers to active contexts.
 void removeContextActivationServiceListener(IContextActivationServiceListener contextActivationServiceListener)
          Unregisters an instance of IContextActivationServiceListener listening for changes to properties of this instance.
 

Method Detail

addContextActivationServiceListener

public void addContextActivationServiceListener(IContextActivationServiceListener contextActivationServiceListener)
Registers an instance of IContextActivationServiceListener to listen for changes to properties of this instance.

Parameters:
contextActivationServiceListener - the instance to register. Must not be null. If an attempt is made to register an instance which is already registered with this instance, no operation is performed.

getActiveContextIds

public Set getActiveContextIds()
Returns the set of identifiers to active contexts.

Notification is sent to all registered listeners if this property changes.

Returns:
the set of identifiers to active contexts. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

removeContextActivationServiceListener

public void removeContextActivationServiceListener(IContextActivationServiceListener contextActivationServiceListener)
Unregisters an instance of IContextActivationServiceListener listening for changes to properties of this instance.

Parameters:
contextActivationServiceListener - the instance to unregister. Must not be null. If an attempt is made to unregister an instance which is not already registered with this instance, no operation is performed.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.